﻿<?xml version="1.0"?>
<doc>
<assembly>
<name>
WRDBExternal
</name>
</assembly>
<members>
<member name="T:WRDB.External.modCommon">
 <summary>
 Commonly used routines in several applications
 </summary>
</member>
<member name="M:WRDB.External.modCommon.StringFormat(System.String,System.Object[])">
 <summary>
 Provide string.format functionality and substitute \n for vbCr, \t for vbTab, and \b for bullet character, \\ for \
 </summary>
 <param name="FormatString">String to format (\n is newline and \t is tab, etc.)</param>
 <param name="Arguments">Format arguments</param>
</member>
<member name="M:WRDB.External.modCommon.StringSplit(System.String,System.String,System.Boolean)">
 <summary>
 Provide string.split functionality where separator is not a character but is a string. 
 Note: individual elements are trimmed of spaces
 </summary>
 <param name="StringToSplit">Original string</param>
 <param name="SeparatorString">String to use as separator</param>
 <param name="RemoveEmptyEntries">If true, will remove empty entries in array</param>
 <returns>Array of components</returns>
 <remarks>For example, if you want to split "A - B" call SplitString("A - B"," - ") to get A,B</remarks>
</member>
<member name="M:WRDB.External.modCommon.MyDataPath">
 <summary>
 Name of directory where data will be stored by default (My Documents>\WRDB)
 </summary>
 <remarks></remarks>
</member>
<member name="M:WRDB.External.modCommon.StringsEqual(System.String,System.String)">
 <summary>
 Wrapper for String.Compare to test if two strings are equal, ignoring case
 </summary>
</member>
<member name="M:WRDB.External.modCommon.FormatSQL(System.String,System.Boolean)">
 <summary>
 Reformat SQL statement so it looks better in a dialog box
 </summary>
 <param name="SqlString">SQL string to be formatted</param>
</member>
<member name="M:WRDB.External.modCommon.WarningMsg(System.String,System.String,System.Exception,System.Boolean,System.String)">
 <summary>
 Display warning or question dialog box
 </summary>
 <param name="WarningText">Main text of dialog box; may have additional text added depending on other arguments; note that following text transformations occur: \n=NewLine; \t=Tab; \b=Bullet. If text contains question mark, will use OK/Cancel buttons and question icon; otherwise will use OK button and warning icon</param>
 <param name="SQLString">Text containing SQL statement text. If present, adds text showing the SQL string</param>
 <param name="ex">Exception; if present, adds text showing exception message</param>
 <param name="ShowRetryCancel">If true, will change buttons to Retry/Cancel and prompt that database/table may be locked and allow user to retry later (caller must loop)</param>
 <param name="Caption">Messagebox caption</param>
</member>
<member name="M:WRDB.External.modCommon.WarningMsgFmt(System.String,System.Object[])">
 <summary>
 Display warning or question dialog box
 </summary>
 <param name="WarningTextFormat">Main text of dialog box (containing format placeholders); note that following text transformations occur: \n=NewLine; \t=Tab; \b=Bullet. If text contains question mark, will use OK/Cancel buttons and question icon; otherwise will use OK button and warning icon</param>
 <param name="Args">String.Format arguments</param>
</member>
<member name="M:WRDB.External.modCommon.ErrorMsg(System.String,System.Exception)">
 <summary>
 Display unhandled error form in a separate thread
 </summary>
 <param name="ErrorText">Text to display on error form</param>
 <param name="ex">Exception object</param>
</member>
<member name="M:WRDB.External.modCommon.ErrorMsg(System.String,System.String,System.Exception)">
 <summary>
 Display unhandled error form in a separate thread
 </summary>
 <param name="ErrorText">Main text of dialog box (containing format placeholders); note that following text transformations occur: \n=NewLine; \t=Tab; \b=Bullet. If text contains question mark, will use OK/Cancel buttons and question icon; otherwise will use OK button and warning icon</param>
 <param name="SQLString">SQL command string</param>
 <param name="ex">Exception object</param>
 <remarks></remarks>
</member>
<member name="M:WRDB.External.modCommon.ErrorMsgFmt(System.String,System.Object[])">
 <summary>
 Display unhandled error form in a separate thread
 </summary>
 <param name="ErrorTextFormat">Main text of dialog box (containing format placeholders); note that following text transformations occur: \n=NewLine; \t=Tab; \b=Bullet. If text contains question mark, will use OK/Cancel buttons and question icon; otherwise will use OK button and warning icon</param>
 <param name="Args">String.Format arguments</param>
</member>
<member name="M:WRDB.External.modCommon.GetControlValue(System.String,System.Windows.Forms.Control@,System.String)">
 <summary>
 Get last (or default) value for specified control that was saved in the registry
 </summary>
 <param name="RegAppName">Name of application</param>
 <param name="Cntl">Control to retrieve value for</param>
 <param name="DefaultValue">If not already in registry, will set to this value (text, checked, or selected index)</param>
 <remarks></remarks>
</member>
<member name="M:WRDB.External.modCommon.GetControlValues(System.String,System.Windows.Forms.Control@)">
 <summary>
 Get last values for all controls on a form that was saved in the registry (default values cannot be set explictly, will use defaults from designer)
 </summary>
 <param name="RegAppName">Name of application</param>
 <param name= "Container">Form or control containing controls to set values for</param>
 <remarks>Want to get and set in order of tag index, as there may be cascading events</remarks>
</member>
<member name="M:WRDB.External.modCommon.SaveControlValue(System.String,System.Windows.Forms.Control@)">
 <summary>
 Save value for specified control to registry
 </summary>
 <param name="RegAppName">Name of application</param>
 <param name="Cntl">Control to set value for</param>
 <remarks></remarks>
</member>
<member name="M:WRDB.External.modCommon.SaveControlValues(System.String,System.Windows.Forms.Control@)">
 <summary>
 Save values for all controls on a form to registry
 </summary>
 <param name="RegAppName">Name of application</param>
 <param name= "Container">Form or control containing controls to set values for</param>
 <remarks>Want to get and set in order of tag index, as there may be cascading events</remarks>
</member>
<member name="M:WRDB.External.modCommon.TestNull(System.Object,System.Object)">
 <summary>
 Test object; if dbnull, nothing, empty string, or minimum value, return default value
 </summary>
</member>
<member name="M:WRDB.External.modCommon.Proper(System.String)">
 <summary>
 Capitalize first character and any characters following a space,|,\,;,.,_,(
 </summary>
</member>
<member name="M:WRDB.External.modCommon.GetKey(WRDB.IniFile.clsIniFile,System.String,System.String,System.String)">
 <summary>
 Retrieve setting from configuration file
 </summary>
 <param name="SectionName">Section Name</param>
 <param name="KeyName">Key Name</param>
 <param name="DefaultKeyText">If section/key not found, returns this value</param>
 <returns></returns>
</member>
<member name="M:WRDB.External.modCommon.ReplaceTooltipAndHelpText(System.Windows.Forms.Control,System.Windows.Forms.ToolTip,System.Windows.Forms.HelpProvider)">
 <summary>
 Cannot embed newline characters in tooltips and help text using VB; 
 Recursively look at all such text and replace \n with Newline and \t with tab
 Will also do this for labels and textbox entries
 </summary>
 <param name="CtlParent">Parent control (start with form)</param>
 <param name="Tool">Name of tooltip provider</param>
 <param name="Help">Name of helpprovider</param>
 <remarks></remarks>
</member>
<member name="M:WRDB.External.modCommon.MyNumber(System.String)">
 <summary>
 Given real number string in culture-invariant format, return value (use in place of CDate)
 </summary>
 <param name="Number">Culture-invariant number format like 1,234.56</param>
 <returns></returns>
 <remarks>Useful when running in non-US culture</remarks>
</member>
<member name="M:WRDB.External.modCommon.MyCDate(System.String)">
 <summary>
 Given date-time string in culture-invariant format, return date value (use in place of CDate)
 </summary>
 <param name="DateString">Culture-invariant string format like MM/dd/yyyy HH:mm</param>
 <returns></returns>
 <remarks>Useful when running in non-US culture</remarks>
</member>
<member name="M:WRDB.External.modCommon.MyDateTimeFormat">
 <summary>
 Given date-time value return short date-time format string that obeys culture preferences (for US, gives MM/dd/yyyy HH:mm)
 </summary>
 <returns></returns>
 <remarks>Cache results to improve performance</remarks>
</member>
<member name="M:WRDB.External.modCommon.MyDateFormat">
 <summary>
 Given date-time value return short date format string that obeys culture preferences (for US, gives MM/dd/yyyy)
 </summary>
 <returns></returns>
 <remarks>Cache results to improve performance</remarks>
</member>
<member name="M:WRDB.External.modCommon.IsDesignMode(System.Windows.Forms.Control)">
 <summary>
 Looks up chain to see if control (or a parent) is in design mode, so some initialization can be skipped to avoid designer errors
 </summary>
 <param name="Cntl">Control to check</param>
 <returns></returns>
 <remarks></remarks>
</member>
<member name="M:WRDB.External.modCommon.RelativePath(System.String)">
 <summary>
 Given a path or file, return the path relative to MyDocuments\WRDB
 </summary>
</member>
<member name="M:WRDB.External.modCommon.AbsolutePath(System.String,System.String)">
 <summary>
 Given a path or file possibly relative to MyDocuments\WRDB, return the absolute path 
 </summary>
</member>
<member name="T:WRDB.External.clsExternalData">
 <summary>
 This encapsulates forms and routines used to establish links to an external database
 </summary>
 <remarks></remarks>
</member>
<member name="E:WRDB.External.clsExternalData.Progress">
 <summary>
 Is raised during long operations (e.g., import/export) so caller can report using UI;
 Should use marquee progressbar as percent complete will not be shown, and can cancel by calling CancelProgress
 </summary>
 <param name="ProgressText">Text to display</param>
</member>
<member name="M:WRDB.External.clsExternalData.CancelProgress">
 <summary>
 Call this during long operation (importing records) to cancel import
 </summary>
</member>
<member name="M:WRDB.External.clsExternalData.#ctor(WRDB.Project.clsProject@)">
 <summary>
 Instantiate class
 </summary>
 <param name="Project">Current project (or Nothing if calling from Graph)</param>
 <remarks></remarks>
</member>
<member name="M:WRDB.External.clsExternalData.#ctor(WRDB.Project.clsProject,System.String,System.String,System.Boolean)">
 <summary>
 Instantiate class using existing project and connection info
 </summary>
 <param name="Project">Current project (or Nothing if calling from Graph)</param>
 <param name="ExistingConnectionName">Connection Name</param>
 <param name="ExistingTableConnection">Table Connection Name</param>
 <param name="CreatePermanentTable">Flag indicating that permanent table should be created</param>
 <remarks></remarks>
</member>
<member name="M:WRDB.External.clsExternalData.#ctor(WRDB.Project.clsProject,WRDB.DataSource.clsData,System.Boolean)">
 <summary>
 Instantiate class using datasource; if previously had opened this data source will restore mapping
 </summary>
 <param name="DataSource">Data source</param>
 <param name="CreatePermanentTable">Flag indicating that permanent table should be created</param>
 <remarks></remarks>
</member>
<member name="M:WRDB.External.clsExternalData.ShowSelectTable(System.Windows.Forms.Form,System.Boolean)">
 <summary>
 Show external connection form and return selected connection info
 </summary>
 <param name="Owner">Parent form for dialog</param>
</member>
<member name="M:WRDB.External.clsExternalData.ShowTableMapping(System.Windows.Forms.Form)">
 <summary>
 Show table mapping form for opening datasource
 </summary>
 <param name="Owner">Parent form for dialog</param>
</member>
<member name="M:WRDB.External.clsExternalData.ShowManageConnections(System.Windows.Forms.Form,System.String)">
 <summary>
 Show external connection form so can manage connections; OK/Cancel replaced by Close button
 </summary>
 <param name="Owner">Parent form for dialog</param>
 <param name="DefaultConnectionName">If provided, sets this as default</param>
</member>
<member name="M:WRDB.External.clsExternalData.GetDB">
 <summary>
 Get database provider for external database
 </summary>
 <returns></returns>
 <remarks></remarks>
</member>
<member name="M:WRDB.External.clsExternalData.GetData(WRDB.Project.clsProject@,System.String@,System.Boolean)">
 <summary>
 Given previously selected database and table connection, acquire the external data.
 </summary>
 <remarks>
 Several ways that data in external table may be assessed:
 1. If Project is Nothing, then assume the data must be imported into a newly created SQLite project (used by Graph)
 2. Else if BypassMapping is false, Project is active project which will either have View created or New table created and imported to
 3. Else if BypassMapping is true, new project will be created which points directly to the external database--tablename is most likely a pre-created view which permanently maps to WRDB (such as BNA)
 </remarks>
</member>
<member name="M:WRDB.External.clsExternalData.GetItem(WRDB.DataSource.clsData,System.Collections.Generic.Dictionary{System.String,System.String},System.String)">
 <summary>
 Return field value associated with standard data field name from datasource
 </summary>
 <param name="DataSource">Data source pointing to open datafile</param>
 <param name="dctFields">Dictionary containing standard data field names (as key) and column names in datasource (value)</param>
 <param name="FieldName">Standard data field name</param>
 <returns>Value in data source column or DBNull if not found or is empty string</returns>
 <remarks></remarks>
</member>
<member name="M:WRDB.External.clsExternalData.GetItem(WRDB.DataSource.clsData,System.String)">
 <summary>
 Return field value associated with specified pcode name from datasource
 </summary>
 <param name="DataSource">Data source pointing to open datafile</param>
 <param name="FieldName">Data field name (PCode)</param>
 <returns>Value in data source column or DBNull if not found or is empty string</returns>
 <remarks></remarks>
</member>
<member name="M:WRDB.External.frmTableMapping.#ctor(System.String,System.String)">
 <summary>
 Instantiate form used to configure table connection
 </summary>
 <param name="ExternalConnection">Name of database connection</param>
 <param name="TableConnection">Name of table connection (if editing) or blank if new</param>
 <remarks></remarks>
</member>
<member name="T:WRDB.External.My.Resources.Resources">
<summary>
  A strongly-typed resource class, for looking up localized strings, etc.
</summary>
</member>
<member name="P:WRDB.External.My.Resources.Resources.ResourceManager">
<summary>
  Returns the cached ResourceManager instance used by this class.
</summary>
</member>
<member name="P:WRDB.External.My.Resources.Resources.Culture">
<summary>
  Overrides the current thread's CurrentUICulture property for all
  resource lookups using this strongly typed resource class.
</summary>
</member>
</members>
</doc>
